home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / system / ezset21.zip / MANUAL.DOC < prev    next >
Text File  |  1993-09-07  |  28KB  |  587 lines

  1.  
  2.                                   EZSET Version 2.1
  3.           
  4.                                        +++++++
  5.           
  6.                                 By McAdams Associates
  7.           
  8.           
  9.           
  10.           
  11.           *****************************************************************
  12.           
  13.           
  14.           
  15.           
  16.                                     **IMPORTANT**
  17.           
  18.               To register EZSET, see "Registering EZSET" on page 9 of 
  19.                                     this manual.
  20.           
  21.           
  22.           
  23.           
  24.           Contents                                 Page
  25.           --------                                 ----
  26.           
  27.           Description.............................. 2
  28.           Hardware Requirements.................... 2
  29.           EZSET's Limitations...................... 2
  30.           How EZSET Works.......................... 2
  31.           Using EZSET in Command Line Mode......... 3
  32.           Editing Strings.......................... 4
  33.           Entering a New String.................... 5
  34.           The Byte Input/Editing Screen............ 5
  35.           Troubleshooting.......................... 7
  36.           Disclaimer - Agreement................... 8
  37.           Registering EZSET........................ 9
  38.           Index.................................... 10 
  39.           
  40.           
  41.           
  42.           
  43.           
  44.           
  45.           
  46.           
  47.           
  48.           
  49.           
  50.           
  51.           
  52.           
  53.           
  54.           
  55.           
  56.               (C)Copyright 1993 by T.C. McAdams.  All Rights Reserved.
  57.           EZSET DESCRIPTION
  58.           -----------------
  59.           
  60.           EZSET is a program designed to make it easy to access ALL of your 
  61.           parallel printer's features, whether directly available from the 
  62.           printer's control panel or not.  Unlike other methods, which 
  63.           either involve programs that come with a predefined library of 
  64.           printer codes (none of which usually match your printer), or 
  65.           which involve writing BASIC programs or batch files, all you need 
  66.           to use EZSET effectively is your printer's manual.  EZSET is 
  67.           designed to make it EASY to send your printer's control codes 
  68.           from the command line or from inside batch files.  In addition, 
  69.           EZSET printer strings can be customized to go automatically to 
  70.           any printer port, using any printer online return value.  
  71.           
  72.           HARDWARE REQUIREMENTS
  73.           ---------------------
  74.           
  75.           EZSET should work on any IBM-compatible computer, running DOS 2.1 
  76.           or better.
  77.           
  78.           EZSET'S LIMITATIONS
  79.           -------------------
  80.           
  81.           EZSET will manage a printer string library containing an 
  82.           arbitrary maximum of 255 printer strings, with each printer 
  83.           string a maximum of 255 characters in length.  EZSET will output 
  84.           strings only through parallel ports 1 through 3.  EZSET will not 
  85.           output through serial ports.
  86.           
  87.           HOW EZSET WORKS
  88.           ---------------
  89.           
  90.           EZSET has two modes, an editor mode and a command line mode.  The 
  91.           editor mode is used to input and edit printer strings.  The 
  92.           command line mode is used to send strings to a printer.  Typing
  93.           
  94.                EZSET [ENTER]
  95.           
  96.           calls EZSET up in editor mode.  Here is what you'll see:
  97.           
  98.                                     Exit Program
  99.           
  100.                                 Edit A Printer String
  101.           
  102.                              Enter A New Printer String
  103.           
  104.           Above the menu choices there is a line telling you to use the 
  105.           arrow keys to move the light bar and to press [ENTER] when your 
  106.           choice is highlighted.  To leave EZSET you would simply highlight 
  107.           "Exit Program" and press the [ENTER] key.  This style of menu is 
  108.           EZSET's main method of getting input, making it difficult to go 
  109.           wrong.  Here is what the different main menu choices do:
  110.           
  111.           
  112.           
  113.           
  114.           
  115.                                           2
  116.           Exit Program
  117.           ------------
  118.           
  119.           Leaves EZSET.
  120.           
  121.           Edit A Printer String
  122.           ---------------------
  123.           
  124.           If there are already some strings defined (in a file called 
  125.           EZSET.LIB), choosing this option gives you a chance to modify 
  126.           them.  Note that EZSET.LIB may be located in any directory 
  127.           defined in your PATH environment variable; EZSET will find it.
  128.           
  129.           Enter A New Printer String
  130.           --------------------------
  131.           
  132.           Choosing this option gives you an opportunity to enter a new 
  133.           string, including determining which printer port the string will 
  134.           go to, and defining what the online return code should be.
  135.           
  136.           Both editing and entering a new string will be covered in detail 
  137.           a little later on.
  138.           
  139.           USING EZSET IN COMMAND LINE MODE
  140.           --------------------------------
  141.           
  142.           After there has been at least one string entered, using EZSET's 
  143.           editing mode, you can send it to your printer by typing
  144.           
  145.                EZSET stringname [ENTER]
  146.           
  147.           If the printer is online (as determined by the return code saved 
  148.           with the string) the string is sent to it.  If the printer is 
  149.           offline (not available) you are told so and EZSET exits with a 
  150.           return code of 255.  EZSET's ability to return an exit code makes 
  151.           it possible to do conditional branching in a batch file.  An 
  152.           example batch file could be something like this:
  153.           
  154.           ECHO OFF
  155.           EZSET stringname
  156.           IF ERRORLEVEL 1 GOTO END
  157.           programname
  158.           :END
  159.           
  160.           Notice that EZSET uses the highest possible ERRORLEVEL return 
  161.           code.  This means that "IF ERRORLEVEL 255 GOTO END" would work 
  162.           equally well.  
  163.           
  164.           In addition to the return code, when a printer is offline a 
  165.           message to that effect is printed to the screen.  And, if you 
  166.           type a nonexistent string name (one that isn't in the library 
  167.           file), EZSET will say so, likewise with a return code of 255.
  168.           
  169.           EZSET is supplied with a sample library of printer strings for an 
  170.           NEC Pinwriter printer.  If you don't have a Pinwriter, feel free 
  171.           
  172.           
  173.           
  174.                                           3
  175.           to play with and experiment with them.  When you've gotten 
  176.           familiar with EZSET they can be erased by deleting the file 
  177.           EZSET.LIB.  Then you'll have a "fresh slate" for inputting your 
  178.           own printer's strings.
  179.           
  180.           EDITING STRINGS
  181.           ---------------
  182.           
  183.           From the main menu press the [DOWN ARROW] key once, to highlight 
  184.           "Edit A Printer String", and press [ENTER].  In the center of the 
  185.           screen you'll see a sorted list of all available printer strings.  
  186.           Across the bottom of the screen is a list of control keys.  
  187.           Notice that you can scroll the string list by using any of the 
  188.           "vertical" cursor-movement keys ([UP ARROW], [DOWN ARROW], 
  189.           [PgUp], [PgDn], [HOME] and [END]).
  190.           
  191.           To the left of the list box is a status indicator showing what 
  192.           the highlighted string's port setting is.  Pressing [F9] takes 
  193.           you to a light bar menu that lets you choose which printer port a 
  194.           particular string should always go to.  The port selected from 
  195.           the "Edit A Printer String" menu applies ONLY to that particular 
  196.           string.  The same menu, reached from the "Enter A New Printer 
  197.           String" main menu selection, will enable you to change the 
  198.           present session's default port setting.  All strings entered 
  199.           after changing the default port will have that as their setting.
  200.           
  201.           To the right of the list box is a status indicator showing what 
  202.           the highlighted string's online code is.  Before a string is sent 
  203.           to a printer from the command line, EZSET "interrogates" the 
  204.           printer to see if it's on and online, to prevent your computer 
  205.           from going into the dreaded "timeout".  For most printers the 
  206.           default value for this will be all that is necessary, so you 
  207.           probably won't need to use this feature.  But if you ever 
  208.           encounter a "rogue printer" that insists on responding 
  209.           differently than others, it can be handy.  Pressing [F10] will 
  210.           take you to yet another light bar menu enabling you to (1) 
  211.           interrogate the printer (with an informative bitwise readout of 
  212.           the return code), (2) to return WITHOUT changing the set value, 
  213.           (3) to return WITH a new value, and, finally, (4) to restore the 
  214.           default value if you find you've chosen unwisely.  An online code 
  215.           selected here (from the edit menu) applies ONLY to the 
  216.           highlighted string.  Changing the default is possible from the 
  217.           "Enter A New Printer String" menu.
  218.           
  219.           Pressing [DELETE] inside the edit menu causes an asterisk ('*') 
  220.           character to appear beside the string name.  This means that the 
  221.           string is marked for deletion, and when the revised EZSET.LIB 
  222.           file is written to disk, at the end of the session, that string 
  223.           will not go with it.  In other words, the string is not truly 
  224.           deleted until you exit EZSET, so you can continue to work with it 
  225.           in the current session.  Pressing [DELETE] yet again will remove 
  226.           the asterisk and the string is then "undeleted".  A string will 
  227.           be automatically marked for deletion if all of its characters 
  228.           have been deleted in the byte editing screen; when it is an 
  229.           "empty" string.
  230.           
  231.           
  232.           
  233.                                           4
  234.           Pressing [F8] lets you rename a string.  After a string has been 
  235.           renamed, the highlighted cursor will "follow" the renamed string 
  236.           to its new location in the list box.
  237.           
  238.           To try out what effect a particular string has on your printer, 
  239.           pressing [F5] will send the highlighted string to the printer.  
  240.           It's often useful to be able to enter a string, try it out, and 
  241.           then go back to the editing screen to modify it on the spot, if 
  242.           necessary.
  243.           
  244.           Finally, pressing [ESC] from this menu will return you to the 
  245.           previous menu, and pressing [ENTER] takes you to the byte editing 
  246.           screen, with the currently highlighted string displayed for 
  247.           editing.  The byte editing screen will be described later, since 
  248.           it's where you go from the "Enter A New Printer String" menu, as 
  249.           well as from this one.
  250.           
  251.           ENTERING A NEW STRING
  252.           ---------------------
  253.           
  254.           From the main menu press down [DOWN ARROW] key twice (or [UP 
  255.           ARROW] once), to highlight "Enter A New Printer String", and 
  256.           press [ENTER].  In the middle of the screen you will see a box 
  257.           for entering a string name.  Unlike DOS path and filenames, 
  258.           anything goes with a string name: letters, numbers and spaces are 
  259.           all okay.  Everything is automatically converted to uppercase as 
  260.           it is entered.
  261.           
  262.           To the left of the entry box, similar to the editing menu, is a 
  263.           status indicator for the output port.  Where the indicator said 
  264.           "String Port Value" in the editing menu, however, it now says 
  265.           "Current Port Value", indicating that the OVERALL, or DEFAULT 
  266.           value can be changed from this menu.  Pressing [F9] takes you to 
  267.           a scroll menu where you select which printer port all 
  268.           subsequently entered strings should go to.
  269.           
  270.           To the right of the entry box is a status indicator for the 
  271.           printer online value.  Where, in the edit menu, it said, "String 
  272.           Online Value", it now says "Current Online Value", indicating 
  273.           that a change (by pressing [F10]) will change the default value, 
  274.           affecting all subsequent (new) strings.
  275.           
  276.           Pressing [ENTER] after entering a string name will take you to 
  277.           the byte editing screen, where the individual bytes of a new 
  278.           setup string can be entered.  Pressing [ESC] at any time returns 
  279.           you to the previous menu.
  280.           
  281.           THE BYTE INPUT/EDITING SCREEN
  282.           -----------------------------
  283.           
  284.           Pressing [ENTER] from both the "Edit A Printer String" menu or 
  285.           the "Enter A New Printer String" menu brings you here.  Across 
  286.           the middle of the screen is a display of string bytes, given in 
  287.           the first row as decimal numbers, and in the second as 
  288.           hexadecimal numbers.  This makes it easier to enter and edit a 
  289.           
  290.           
  291.           
  292.                                           5
  293.           string, since a majority of printer manuals use both to 
  294.           illustrate escape codes.  Above the byte display are the byte 
  295.           numbers.  Below the display is an arrow, used as a cursor 
  296.           indicating which byte we're operating on.  On the bottom of the 
  297.           screen is a list of applicable keys:
  298.           
  299.           [ESC]       Returns you to the previous menu.
  300.           
  301.           [-><-]      The left and right arrow keys move the arrow cursor 
  302.                       left and right within the string.
  303.           
  304.           [PgUp]      "Jumps" the cursor 15 bytes to the left, towards the 
  305.                       beginning of the string.  Scrolls backward through 
  306.                       the string.
  307.           
  308.           [PgDn]      "Jumps" the cursor 15 bytes to the right, towards the 
  309.                       end of the string.  Scrolls forward through the 
  310.                       string.
  311.           
  312.           [HOME]      Repositions the cursor to byte 0 of the string.
  313.           
  314.           [END]       Repositions the cursor to the first byte FOLLOWING
  315.                       the end of the string.  Used for appending new bytes 
  316.                       to the end of a string.
  317.           
  318.           [INS]       The insert key moves the bytes above and to the right 
  319.                       of the cursor one slot to the right, opening up a 
  320.                       space for inserting a new byte.
  321.           
  322.           [DEL]       Deletes the byte above the cursor.
  323.           
  324.           Above the byte display are directions:
  325.           
  326.           "Input the byte of the printer string indicated by the [UP ARROW] 
  327.           using <C>haracters, <D>ecimal numbers, or <H>ex numbers, then 
  328.           press [ENTER]. . ."
  329.           
  330.           followed by a prompt.  EZSET's ease of use comes partly through 
  331.           its ability to accept a byte value as a character, decimal number 
  332.           or hex number, all of which can be equivalent, depending on how 
  333.           they are interpreted.
  334.           
  335.           After entering a value and pressing [ENTER], EZSET says
  336.           
  337.           "Is this a <C>haracter, <D>ecimal number or <H>ex number?"
  338.           
  339.           at which point you must press "C", "D" or "H", to indicate how 
  340.           what you've typed should be interpreted.  A few examples:
  341.           
  342.           To enter an escape code (ASCII character 27), DON'T press [ESC], 
  343.           which will only return you to the previous menu.  Instead, type
  344.           
  345.                27 [ENTER]
  346.                D
  347.           
  348.           
  349.           
  350.           
  351.                                           6
  352.           You could equally well have typed
  353.           
  354.                1b [ENTER]
  355.                H
  356.           
  357.           since 27 decimal is THE SAME AS 1b hex, and EZSET has no trouble 
  358.           keeping them straight if you tell it what the number base is ("D" 
  359.           for decimal, in the first instance, "H" for hex in the second).
  360.           
  361.           Entering literal string characters (as in the letter "A") is just 
  362.           as easy.  Just press "C" to indicate that this is a <C>haracter.  
  363.           If you type a string more than 1 character long and tell EZSET 
  364.           it's a character, only the FIRST BYTE of the input will be 
  365.           interpreted as a character.
  366.           
  367.           As each new byte is entered the decimal and hex values of that 
  368.           byte will be displayed over the arrow cursor, which will then 
  369.           move to the right, awaiting the next byte.  As the number of 
  370.           characters entered grows, the byte display will scroll to keep 
  371.           up.  You can move back and forth inside the string for editing, 
  372.           at any time, using the cursor movement keys detailed above.  When 
  373.           you're through entering or editing your string, press [ESC].
  374.           
  375.           TROUBLESHOOTING
  376.           ---------------
  377.           
  378.           Most of the time, looking up printer codes and inputting them to 
  379.           EZSET will be a trouble-free operation.  But what to do if the 
  380.           results are not what you expect?  This section suggests a method 
  381.           for "cracking the tough nuts".
  382.           
  383.           When you cannot make your printer behave as you wish, it may be 
  384.           helpful to see how another program does it.  This presupposes, of 
  385.           course, that you have a word processor or the like that is able 
  386.           to switch your printer in the desired fashion.  The first step in 
  387.           finding out how this other program works its magic is to capture 
  388.           its output to a disk file, to PRINT TO DISK.  Most word 
  389.           processors and text editors are able to do this.  If yours isn't, 
  390.           it is still possible to capture print output to a disk file by 
  391.           using one of the many shareware utilities available for the 
  392.           purpose.  Check with your local shareware disk distributor, or, 
  393.           if you have a modem, log on to your favorite BBS and conduct a 
  394.           keyword search using, for example, "PRINT TO DISK".  That should 
  395.           net some possibilities.
  396.           
  397.           Once you are set up to print to disk, simplify your formatting as 
  398.           much as you can: no top margin, no left margin, and so on.  Then, 
  399.           type "Hello!" and print this file to disk.  Call the file HELLO.
  400.           
  401.           The next step involves using DEBUG, a utility that comes with 
  402.           DOS, to help you decipher what's going on.  Here's what you do:
  403.           
  404.           >DEBUG HELLO
  405.           -D
  406.  
  407.           
  408.           
  409.           
  410.                                           7
  411.           23CC:0100  1C 40 1B 36 1B 74 01 1B-43 00 0B 1B 6B 00 1B 78   
  412.           23CC:0110  01 1B 50 1B 52 00 1B 4A-B4 48 65 6C 6C 6F 21 0D   
  413.           23CC:0120  1B 4A FF 1B 4A FF 1B 4A-FF 1B 4A FF 1B 4A FF 1B   
  414.           23CC:0130  4A FF 1B 4A FF 1B 4A 0F-1C 40 0D F9 EB 0A 50 B0   
  415.           23CC:0140  03 B4 FF E8 03 00 58 F8-C3 57 26 8B 7F 04 2E 89   
  416.           23CC:0150  3E C8 88 26 88 05 26 88-65 01 50 2E A1 D7 88 26   
  417.           23CC:0160  89 45 02 58 3C 01 75 0A-26 89 55 04 26 89 4D 06   
  418.           23CC:0170  EB 5A 3C 02 75 06 26 89-55 04 EB 50 3C 07 74 E8   
  419.           
  420.           To the right of this (which there isn't room to show here) you 
  421.           would see a straight ASCII representation of the above.  At 
  422.           offset 119 hex there is our friendly "Hello!".  Your own "hello" 
  423.           file will certainly differ from this one; what you are interested 
  424.           in is everything preceding the text.  It's now time to call your 
  425.           printer's manual into play again.  Start at the beginning, 
  426.           looking up each code in turn, and write down what it does.  By 
  427.           the time you get to the "Hello!" you should have a good idea of 
  428.           exactly what steps are necessary to get what you want out of your 
  429.           printer.  Since EZSET accepts hexadecimal input, there is no need 
  430.           to translate, and it should now be possible to get the results 
  431.           you want.
  432.           
  433.           DISCLAIMER - AGREEMENT
  434.           ----------------------
  435.           
  436.           Users of EZSET must accept this disclaimer of warranty:
  437.           
  438.           "EZSET is supplied as is.  The author disclaims all warranties, 
  439.           expressed or implied, including, without limitation, the 
  440.           warranties of merchantability and of fitness for any purpose.
  441.           The author assumes no liability for damages, direct or 
  442.           consequential, which may result from the use of EZSET."
  443.           
  444.           EZSET is a "shareware program" and is provided at no charge
  445.           to the user for evaluation.  Feel free to share it with your
  446.           friends, but please do not give it away altered or as part of
  447.           another system.  The essence of "user-supported" software is to
  448.           provide personal computer users with quality software without
  449.           high prices, and yet to provide incentive for programmers to
  450.           continue to develop new products.  If you find this program
  451.           useful and find that you are using EZSET and continue to use
  452.           EZSET after a reasonable trial period, you must make a 
  453.           registration payment of $20 to McAdams Associates.  The $20
  454.           registration fee will license one copy for use on any one
  455.           computer at any one time.  You must treat this software just like
  456.           a book.  An example is that this software may be used by any
  457.           number of people and may be freely moved from one computer
  458.           location to another, so long as there is no possibility of it
  459.           being used at one location while it's being used at another.
  460.           Just as a book cannot be read by two different persons at the
  461.           same time.
  462.           
  463.           Commercial users of EZSET must register and pay for their
  464.           copies of EZSET within 30 days of first use or their license
  465.  
  466.           
  467.           
  468.           
  469.                                           8
  470.           is withdrawn.  Site-License arrangements may be made by 
  471.           contacting McAdams Associates.
  472.           
  473.           Anyone distributing EZSET for any kind of remuneration must
  474.           first contact McAdams Associates at the address below for 
  475.           authorization.  This authorization will be automatically granted 
  476.           to distributors recognized by the ASP as adhering to its 
  477.           guidelines for shareware distributors, and such distributors may 
  478.           begin offering EZSET immediately (However McAdams Associates must 
  479.           still be advised so that the distributor can be kept up-to-date 
  480.           with the latest version of EZSET.).
  481.           
  482.           You are encouraged to pass a copy of EZSET along to your
  483.           friends for evaluation.  Please encourage them to register their
  484.           copy if they find that they can use it.
  485.           
  486.           Since this is shareware and I am a member of the Association of 
  487.           Shareware Professionals, please read the following:
  488.           
  489.                "This program is produced by a member of the 
  490.                Association of Shareware Professionals (ASP).  ASP 
  491.                wants to make sure that the shareware principle works 
  492.                for you. If you are unable to resolve a shareware-
  493.                related problem with an ASP member by contacting the 
  494.                member directly, ASP may be able to help. The ASP 
  495.                Ombudsman can help you resolve a dispute or problem 
  496.                with an ASP member, but does not provide technical 
  497.                support for members' products. Please write to the ASP 
  498.                Ombudsman at 545 Grover Road, Muskegon, MI 49442
  499.                or send a CompuServe message via CompuServe Mail to ASP 
  500.                Ombudsman 70007,3536."
  501.                
  502.           REGISTERING EZSET
  503.           -----------------
  504.           
  505.           Registering EZSET costs $20 and includes one year's free support 
  506.           by phone, mail and CompuServe e-mail, free bug fixes, the latest 
  507.           version of EZSET, plus TWO handy utility programs: 1) SEARCH, a 
  508.           multitalented disk scanning file-finder program, and 2) TO/RET, a 
  509.           "two-in-one" combo that work together, enabling you to change to 
  510.           any disk/directory and return instantly to your starting point.
  511.           
  512.           To register EZSET, simply print and fill out the file 
  513.           REGISTER.DOC and send it, along with $20 (checks or M.O.s drawn 
  514.           on a U.S. bank only, please) to:
  515.           
  516.                                  McAdams Associates
  517.                                   P.O. Box 835505 
  518.                              Richardson, TX  75083-5505
  519.           
  520.                                  CIS PPN 70353,1644
  521.           
  522.           
  523.           
  524.           
  525.           
  526.           
  527.           
  528.                                           9
  529.           INDEX
  530.           -----
  531.           
  532.           
  533.           
  534.           
  535.           [-><-] arrow keys, 6
  536.           Batch files, 3
  537.           Byte editing screen, 5-7
  538.           Changing online value
  539.                default or overall, 5
  540.                for individual strings, 4
  541.           Changing port setting
  542.                default or overall, 5
  543.                for individual strings, 4
  544.           [DEL] delete key
  545.                for erasing an entire string, 4
  546.                for erasing a single byte, 6
  547.           Editing a string, 3, 4, 5-7
  548.           [END] key, 6
  549.           Entering a new string, 3, 5
  550.           ERRORLEVEL return code, 3
  551.           Escape codes (producing), 6-7
  552.           [ESC] escape key, 5, 6, 7
  553.           Exiting EZSET, 3
  554.           [F5] key, see Outputting a string from inside EZSET
  555.           [F8] key, see Renaming a string
  556.           [F9] key, see Printer ports
  557.           [F10] key, see Printer return code
  558.           Hardware requirements, 2
  559.           [HOME] key, 6
  560.           [INS] insert key, 6
  561.           Library file (EZSET.LIB), 2, 3, 4
  562.                and DOS' PATH, 3
  563.           Light bar menus, 2, 4, 5
  564.           Limitations, 2
  565.           Main menu, 2-3
  566.           Maximum length of strings, 2
  567.           Maximum number of strings, 2
  568.           Online return code, see Printer return code
  569.           Outputting a string from inside EZSET, 5
  570.           [PgDn] page down key, 6
  571.           [PgUp] page up key, 6
  572.           Printer ports, 2, 3
  573.                default or overall, 5
  574.                for individual strings, 4
  575.           Printer return code, 2, 3, 4
  576.           Registering EZSET, 9
  577.           Renaming a string, 5
  578.           Scrolling menus, see Light bar menus
  579.           Starting EZSET
  580.                in command line mode, 3
  581.                in editor mode, 2
  582.           Troubleshooting, 7-8
  583.           
  584.           
  585.           
  586.           
  587.                                          10